doc: nrf-bm: libraries: timer: updates to BM timer documentation#459
Merged
eivindj-nordic merged 1 commit intoNov 18, 2025
Merged
Conversation
github-actions
Bot
added
changelog-entry-required
eivindj-nordic
force-pushed
the
doc_bm_timer_update
branch
from
97ccd63 to
a7a708c
Compare
|
You can find the documentation preview for this PR here. |
eivindj-nordic
force-pushed
the
doc_bm_timer_update
branch
from
a7a708c to
2580f57
Compare
anhmolt
approved these changes
Nov 12, 2025
|
|
||
| Timer library | ||
| ############# | ||
| BM Timer library |
Contributor
There was a problem hiding this comment.
This looks a bit ugly in my opinion. I would follow the wording used in the bm_zms library and such and write instead the following:
Suggested change
| BM Timer library | |
| Bare Metal Timer library |
At the bare minimum we need to align everything to the same style, one way or the other.
Contributor
Author
There was a problem hiding this comment.
Updated to Bare Metal
eivindj-nordic
force-pushed
the
doc_bm_timer_update
branch
from
2580f57 to
4073eab
Compare
b-gent
reviewed
Nov 18, 2025
| :depth: 2 | ||
|
|
||
| The timer library allows the application to create multiple timer instances. | ||
| The BM Timer is a library that is wrapped on top of the Zephyr Timers functionality that is implemented using the GRTC peripheral. |
Contributor
There was a problem hiding this comment.
Suggested change
| The BM Timer is a library that is wrapped on top of the Zephyr Timers functionality that is implemented using the GRTC peripheral. | |
| The Bare Metal (BM) Timer library provides a wrapper around Zephyr's Timers functionality, utilizing the GRTC peripheral. |
| The BM Timer is a library that is wrapped on top of the Zephyr Timers functionality that is implemented using the GRTC peripheral. | ||
|
|
||
| Functions such as starting and stopping timers, checking for timeouts, and invoking user-defined timeout handlers are all managed within the GRTC interrupt handler. | ||
| The BM Timer has a resolution of 1 µs and is able to run in all power modes. |
Contributor
There was a problem hiding this comment.
Suggested change
| The BM Timer has a resolution of 1 µs and is able to run in all power modes. | |
| The BM Timer has a resolution of 1 µs and can run in all power modes. |
|
|
||
| Functions such as starting and stopping timers, checking for timeouts, and invoking user-defined timeout handlers are all managed within the GRTC interrupt handler. | ||
| The BM Timer has a resolution of 1 µs and is able to run in all power modes. | ||
| This gives the capability of waking up the system after a period or at specific intervals, independent of power modes. |
Contributor
There was a problem hiding this comment.
Suggested change
| This gives the capability of waking up the system after a period or at specific intervals, independent of power modes. | |
| This allows for waking up the system after a specific period or at specific intervals, independent of power modes. |
| Functions such as starting and stopping timers, checking for timeouts, and invoking user-defined timeout handlers are all managed within the GRTC interrupt handler. | ||
| The BM Timer has a resolution of 1 µs and is able to run in all power modes. | ||
| This gives the capability of waking up the system after a period or at specific intervals, independent of power modes. | ||
| The BM timer allows the application to create multiple timer instances each with dedicated user defined timeout handlers. |
Contributor
There was a problem hiding this comment.
Suggested change
| The BM timer allows the application to create multiple timer instances each with dedicated user defined timeout handlers. | |
| The BM Timer allows the application to create multiple timer instances, each with dedicated, user defined timeout handlers. |
eivindj-nordic
force-pushed
the
doc_bm_timer_update
branch
from
4073eab to
64b0b9f
Compare
Updates to BM timer documentation. Signed-off-by: Eivind Jølsgard <eivind.jolsgard@nordicsemi.no>
eivindj-nordic
force-pushed
the
doc_bm_timer_update
branch
from
64b0b9f to
6730d95
Compare
b-gent
approved these changes
Nov 18, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Updates to BM timer documentation.